[Kotlin Sync] Add additional SearchOperator helper methods for the rest of the Atlas Search operators #87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-kotlin-sync ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rachel-mack
changed the title
rustagir
suggested changes
Mar 26, 2025
source/whats-new.txt
Outdated
| @@ -42,6 +42,10 @@ and features: | |||
| the :ref:`MONGODB-OIDC: Kubernetes <kotlin-sync-auth-kubernetes>` | |||
| section of the Enterprise Authentication Mechanisms guide | |||
|
|
|||
| .. replacement:: atlas-query-operators | |||
|
|
|||
| the `SearchOperator Interface API documentation <{+api+}/com/mongodb/client/model/search/SearchOperator.html>`__ | |||
There was a problem hiding this comment.
S: there's no search page but there is a section on the Aggregation page. Consider adding a note there?
rachel-mack
force-pushed
the
DOCSP-48104
branch
from
5ae6fc7 to
0ea55ce
Compare
rustagir
suggested changes
Mar 27, 2025
source/aggregation.txt
Outdated
Comment on lines
83
to
86
| .. _kotlin-sync-atlas-search-stage: | ||
|
|
||
| Pipelines Stages for Atlas Search | ||
| --------------------------------- |
There was a problem hiding this comment.
S: Consider moving this section after the main aggregation examples on this page. Also consider renaming this section to just Atlas Search and then creating a subsection after the paragraph called Create a Search Query or something like that?
source/aggregation.txt
Outdated
Comment on lines
88
to
93
| :atlas:`Atlas Search </atlas-search>` queries take the form of an aggregation pipeline stage. Atlas | ||
| Search provides ``$search`` and ``$searchMeta`` stages, both of which must be the first | ||
| stage in any query pipeline. For more information about Atlas pipeline stages, | ||
| see the :atlas:`Choose the Aggregation Pipeline Stage | ||
| </atlas-search/query-syntax/>` page in the Atlas | ||
| manual. |
There was a problem hiding this comment.
S: simplify/combine sentences
Suggested change
| :atlas:`Atlas Search </atlas-search>` queries take the form of an aggregation pipeline stage. Atlas | |
| Search provides ``$search`` and ``$searchMeta`` stages, both of which must be the first | |
| stage in any query pipeline. For more information about Atlas pipeline stages, | |
| see the :atlas:`Choose the Aggregation Pipeline Stage | |
| </atlas-search/query-syntax/>` page in the Atlas | |
| manual. | |
| You can perform an :atlas:`Atlas Search </atlas-search>` query by creating an aggregation pipeline | |
| that contains one of the following pipeline stages: | |
| - ``$search`` | |
| - ``$searchMeta`` | |
| For more information about Atlas pipeline stages, see the :atlas:`Choose the Aggregation Pipeline Stage | |
| </atlas-search/query-syntax/>` page in the Atlas documentation. |
source/aggregation.txt
Outdated
| </atlas-search/query-syntax/>` page in the Atlas | ||
| manual. | ||
|
|
||
| .. sharedinclude:: dbx/jvm/atlas-search-operator-helpers.rst |
There was a problem hiding this comment.
S: consider revising the language in the table in this shared include to have the first column header be Operator instead of operation (as this is what they are referred to in the linked atlas docs`
source/aggregation.txt
Outdated
Comment on lines
99
to
115
| .. code-block:: kotlin | ||
|
|
||
| val searchStage: Bson = Aggregates.search( | ||
| SearchOperator.compound() | ||
| .filter( | ||
| listOf( | ||
| SearchOperator.text(fieldPath("genres"), "Drama"), | ||
| SearchOperator.phrase(fieldPath("cast"), "sylvester stallone"), | ||
| SearchOperator.numberRange(fieldPath("year")).gtLt(1980, 1989), | ||
| SearchOperator.wildcard(fieldPath("title"), "Rocky *") | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| .. replacement:: searchoperator-interface-api-docs | ||
|
|
||
| the `SearchOperator Interface API documentation <{+core-api+}/client/model/search/SearchOperator.html>`__ |
There was a problem hiding this comment.
S: correct the indentation of the replacement content
source/aggregation.txt
Outdated
|
|
||
| .. sharedinclude:: dbx/jvm/atlas-search-operator-helpers.rst | ||
|
|
||
| .. replacement:: atlas-query-operators-example |
There was a problem hiding this comment.
S: in the docs-shared file - change the code description to actually reference the strings as they appear in the text. This is helpful for making sure users see the 1:1 mapping of the description to the code example
i.e
The following code creates a search stage for a pipeline with the following filters:
genresarray field includes"drama"
etc
source/aggregation.txt
Outdated
Comment on lines
99
to
112
| .. code-block:: kotlin | ||
|
|
||
| val searchStage: Bson = Aggregates.search( | ||
| SearchOperator.compound() | ||
| .filter( | ||
| listOf( | ||
| SearchOperator.text(fieldPath("genres"), "Drama"), | ||
| SearchOperator.phrase(fieldPath("cast"), "sylvester stallone"), | ||
| SearchOperator.numberRange(fieldPath("year")).gtLt(1980, 1989), | ||
| SearchOperator.wildcard(fieldPath("title"), "Rocky *") | ||
| ) | ||
| ) | ||
| ) | ||
|
|
There was a problem hiding this comment.
S: use a literalinclude and include output
source/whats-new.txt
Outdated
Comment on lines
47
to
48
| the :ref:`Pipelines Stages for Atlas Search | ||
| <kotlin-sync-atlas-search-stage>` section |
There was a problem hiding this comment.
Suggested change
| the :ref:`Pipelines Stages for Atlas Search | |
| <kotlin-sync-atlas-search-stage>` section | |
| the :ref:`kotlin-sync-atlas-search-stage` section of the Aggregation guide |
rustagir
approved these changes
Apr 1, 2025
github-actions bot
pushed a commit
that referenced
this pull request
Apr 2, 2025
…st of the Atlas Search operators (#87) * atlas search page * aggregation section * link * fix link * eg search stage * fix core-api usage * RR review * add projection * format * eg * wip * wip * wip * WIP * Update whats-new.txt --------- Co-authored-by: Rea Rustagi <[email protected]> Co-authored-by: rustagir <[email protected]> (cherry picked from commit 80461ae)
rachel-mack
added a commit
that referenced
this pull request
Apr 2, 2025
…st of the Atlas Search operators (#87) (#91) * atlas search page * aggregation section * link * fix link * eg search stage * fix core-api usage * RR review * add projection * format * eg * wip * wip * wip * WIP * Update whats-new.txt --------- Co-authored-by: Rea Rustagi <[email protected]> Co-authored-by: rustagir <[email protected]> (cherry picked from commit 80461ae) Co-authored-by: Rachel Mackintosh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-48104
There is no atlas search page in this docs set.
Staging Links
Self-Review Checklist